Python project checklist

The following files / directories are present

Mandatory

The presence of the following files is mandatory (assuming: this is a Python project, it uses Git as its SCM, etc.)

• .git/
• .gitignore
• Makefile
• README.md
• noxfile.py (or tox.ini)
• poetry.lock
• pyproject.toml
• ruff.toml
• src/
• setup.cfg
• tests/

Note: this can be tested using [[Abilian DevTools]] (command adt cruft).

Highly recommended

• CHANGELOG.md
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
• DCO.txt
• SECURITY.md

Optional

For heroku

• Procfile
• requirements.txt
• runtime.txt

#heroku #devtools

Page last modified: 2024-11-13 09:17:00